Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Convert Minimum Accounts Memo to Markdown #322

Merged
merged 5 commits into from
Apr 8, 2024
Merged

Convert Minimum Accounts Memo to Markdown #322

merged 5 commits into from
Apr 8, 2024

Conversation

allejo
Copy link
Contributor

@allejo allejo commented Mar 31, 2024

This PR converts the PDF to markdown but also touches the CSS to add support for footnotes and set a precedent on how to handle images with captions.

Closes #311

@allejo allejo requested a review from a team as a code owner March 31, 2024 18:37
@netlify Netlify
Copy link

netlify bot commented Mar 31, 2024 •
edited
Loading

✅ Deploy Preview for cal-itp-website ready!

Name Link
🔨 Latest commit c844946
🔍 Latest deploy log https://app.netlify.com/sites/cal-itp-website/deploys/660e2449d6de43000814dd63
😎 Deploy Preview https://deploy-preview-322--cal-itp-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@allejo allejo mentioned this pull request Apr 1, 2024
Merged
@allejo allejo requested a review from mrose914 April 1, 2024 00:37
thekaveman
thekaveman requested changes Apr 1, 2024
View reviewed changes
Copy link
Member

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great work on the footnotes especially!

One tiny change requested to get the pill filtering to work.

And one question for Marissa.

src/_resources/fact-sheet-minimum-account-requirements-for-transit-riders.md Outdated Show resolved Hide resolved
src/_resources/fact-sheet-minimum-account-requirements-for-transit-riders.md Show resolved Hide resolved
mrose914
mrose914 suggested changes Apr 1, 2024
View reviewed changes
Copy link

@mrose914 mrose914 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! One add'l change is to see if we can make the font size of the footnotes a size or two smaller than the rest of the text on the page and/or potentially add a bit more space above just to clearly distinguish it from the body of the content. Below is a footnote example from MobiMart with the smaller font. Thank you!
Screenshot 2024-04-01 at 1 32 41 PM

src/_resources/fact-sheet-minimum-account-requirements-for-transit-riders.md Show resolved Hide resolved
allejo
allejo commented Apr 4, 2024
View reviewed changes
src/stylesheets/main.css
}

.footnotes ol::before {
content: "Footnotes";
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not concerned about this from an accessibility perspective because the <div> that Kramdown generates has a role="doc-endnotes".

@allejo allejo requested review from thekaveman and mrose914 April 4, 2024 03:56
thekaveman
thekaveman approved these changes Apr 8, 2024
View reviewed changes
Copy link
Member

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice 👍

mrose914
mrose914 approved these changes Apr 8, 2024
View reviewed changes
Copy link

@mrose914 mrose914 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you!

@allejo allejo merged commit 189419d into main Apr 8, 2024
5 checks passed
@allejo allejo deleted the feat/pdf-html-min-accounts-memo branch April 8, 2024 20:05
@machikoyasuda
Copy link
Member

@allejo Hey Vlad - I'm trying to match the footnote style set here in #364 and #354 - but I can't figure out how you get the doc-backlink to show up. What is this sorcery?
image

Also, question, is having a heading called Footnotes a best practice/requirement?

@allejo
Copy link
Contributor Author

allejo commented Jul 29, 2024

@machikoyasuda okay, so there's some stuff to take note of for footnotes.

  1. I am using Kramdown syntax for footnotes; this is not a CommonMark standard

    ...about 1 in 4 people in California are unbanked[^1] or underbanked[^2]...

[^1]: Unbanked refers to people who have no access to a checking or savings account with an FDIC insured institution.
[^2]: Underbanked refers to people who have a checking or savings account but regularly rely on alternative financial services such as money orders or payday loans.

    Source: https://github.com/cal-itp/calitp.org/pull/322/files#diff-4abe0f39e690bd5a0e8e745532e5b06dadbe649f4a0750076546847e38aba8a5R11-R19

  2. Kramdown will automatically generate the "footnotes" section for you once you've included at least one footnote. I added the Footnotes "heading" via CSS so that it's visually there (this is part of Jekyll's rendered markdown, so you can't edit anything in the middle easily), but it doesn't tell screen readers to treat it like a heading. Kramdown automatically adds the doc-noteref and doc-endnote roles to that footnotes list, which are roles specified in WAI-ARIA 1.0

    And I've got some CSS to make the UI/UX visually appealing, https://github.com/cal-itp/calitp.org/pull/322/files#diff-4e9ead19074dc06fa9b4dce5cbbb7b06d97725dc022be3f4263abf99a02ec64fR221-R257

@machikoyasuda machikoyasuda mentioned this pull request Jul 29, 2024
Merged
15 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mrose914 mrose914 mrose914 approved these changes

@thekaveman thekaveman thekaveman approved these changes

Assignees

@allejo allejo

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Convert existing Minimum Accounts Memo as html
4 participants
@allejo @machikoyasuda @thekaveman @mrose914